<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Aria: ArRatioInputRobotJoydrive Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Aria
   &#160;<span id="projectnumber">2.9.4</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classArRatioInputRobotJoydrive.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classArRatioInputRobotJoydrive-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ArRatioInputRobotJoydrive Class Reference<div class="ingroups"><a class="el" href="group__OptionalClasses.html">Optional Classes</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>Use robot's joystick to control an <a class="el" href="classArActionRatioInput.html" title="Action that requests motion based on abstract ratios provided by diferent input sources. ">ArActionRatioInput</a> action and drive the robot.  
 <a href="classArRatioInputRobotJoydrive.html#details">More...</a></p>

<p><code>#include &lt;ArRatioInputRobotJoydrive.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a03c97bc64b198063d6e1d86957933dc0"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArRatioInputRobotJoydrive.html#a03c97bc64b198063d6e1d86957933dc0">ArRatioInputRobotJoydrive</a> (<a class="el" href="classArRobot.html">ArRobot</a> *robot, <a class="el" href="classArActionRatioInput.html">ArActionRatioInput</a> *input, int priority=75, bool requireDeadmanPushed=true)</td></tr>
<tr class="memdesc:a03c97bc64b198063d6e1d86957933dc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a03c97bc64b198063d6e1d86957933dc0">More...</a><br /></td></tr>
<tr class="separator:a03c97bc64b198063d6e1d86957933dc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a14df1190eae5f64b9aa380939dcb6e03"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a14df1190eae5f64b9aa380939dcb6e03"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classArRatioInputRobotJoydrive.html#a14df1190eae5f64b9aa380939dcb6e03">~ArRatioInputRobotJoydrive</a> ()</td></tr>
<tr class="memdesc:a14df1190eae5f64b9aa380939dcb6e03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a14df1190eae5f64b9aa380939dcb6e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a8177b3eaba91c3a5876ef4592883069b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8177b3eaba91c3a5876ef4592883069b"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>fireCallback</b> (void)</td></tr>
<tr class="separator:a8177b3eaba91c3a5876ef4592883069b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:aec0869536d3a728f988a3f86c492634c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aec0869536d3a728f988a3f86c492634c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myDeadZoneLast</b></td></tr>
<tr class="separator:aec0869536d3a728f988a3f86c492634c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b988132374630f49e03479a46248f10"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7b988132374630f49e03479a46248f10"></a>
<a class="el" href="classArFunctorC.html">ArFunctorC</a>&lt; <a class="el" href="classArRatioInputRobotJoydrive.html">ArRatioInputRobotJoydrive</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>myFireCB</b></td></tr>
<tr class="separator:a7b988132374630f49e03479a46248f10"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6518f3d0f1f3a6348b0a9f286841f36e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6518f3d0f1f3a6348b0a9f286841f36e"></a>
<a class="el" href="classArActionRatioInput.html">ArActionRatioInput</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>myInput</b></td></tr>
<tr class="separator:a6518f3d0f1f3a6348b0a9f286841f36e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3f559ef789ad67f51b285dca4ad17fb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3f559ef789ad67f51b285dca4ad17fb"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>myRequireDeadmanPushed</b></td></tr>
<tr class="separator:ad3f559ef789ad67f51b285dca4ad17fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aedb6eef9ae046b4f3c15dc710d1e383c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aedb6eef9ae046b4f3c15dc710d1e383c"></a>
<a class="el" href="classArRobot.html">ArRobot</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>myRobot</b></td></tr>
<tr class="separator:aedb6eef9ae046b4f3c15dc710d1e383c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6ed5f98f587b080ed6da7fda18d7291"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae6ed5f98f587b080ed6da7fda18d7291"></a>
<a class="el" href="classArRobotJoyHandler.html">ArRobotJoyHandler</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>myRobotJoyHandler</b></td></tr>
<tr class="separator:ae6ed5f98f587b080ed6da7fda18d7291"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Use robot's joystick to control an <a class="el" href="classArActionRatioInput.html" title="Action that requests motion based on abstract ratios provided by diferent input sources. ">ArActionRatioInput</a> action and drive the robot. </p>
<p>This class connects the joystick data obtained from the robot's built in joystick port (if it has one, not all robots have a joystick port) to an <a class="el" href="classArActionRatioInput.html" title="Action that requests motion based on abstract ratios provided by diferent input sources. ">ArActionRatioInput</a> which drives the robot. (See <a class="el" href="classArRatioInputJoydrive.html" title="Use computer joystick to control an ArActionRatioInput and drive the robot. ">ArRatioInputJoydrive</a> for a similar class that uses a joystick plugged in to the computer.)</p>
<p>A callback is attached to the <a class="el" href="classArActionRatioInput.html" title="Action that requests motion based on abstract ratios provided by diferent input sources. ">ArActionRatioInput</a> object which reads joystick information using an <a class="el" href="classArRobotJoyHandler.html" title="Interfaces to a joystick on the robot&#39;s microcontroller. ">ArRobotJoyHandler</a> object, and sets requested drive rations on the <a class="el" href="classArActionRatioInput.html" title="Action that requests motion based on abstract ratios provided by diferent input sources. ">ArActionRatioInput</a> object.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classArRatioInputJoydrive.html" title="Use computer joystick to control an ArActionRatioInput and drive the robot. ">ArRatioInputJoydrive</a> </dd>
<dd>
<a class="el" href="classArActionRatioInput.html" title="Action that requests motion based on abstract ratios provided by diferent input sources. ">ArActionRatioInput</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a03c97bc64b198063d6e1d86957933dc0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ArRatioInputRobotJoydrive::ArRatioInputRobotJoydrive </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classArRobot.html">ArRobot</a> *&#160;</td>
          <td class="paramname"><em>robot</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classArActionRatioInput.html">ArActionRatioInput</a> *&#160;</td>
          <td class="paramname"><em>input</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>priority</em> = <code>75</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>requireDeadmanPushed</em> = <code>true</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">robot</td><td>robot </td></tr>
    <tr><td class="paramname">input</td><td>Action to attach to and use to drive the robot. </td></tr>
    <tr><td class="paramname">priority</td><td>Priority of this joystick input handler with respect to other input objects attached to the <em>input</em> action object. </td></tr>
    <tr><td class="paramname">requireDeadmanPushed</td><td>if this is true the joystick "dead man" button must be pushed for us to drive. If this is false we'll follow the joystick input no matter what </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>ArRatioInputRobotJoydrive.h</li>
<li>ArRatioInputRobotJoydrive.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="classArRatioInputRobotJoydrive.html">ArRatioInputRobotJoydrive</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
